<?php
/**
 * The MIT License
 *
 * Copyright (c) <year> <copyright holders>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author Damiano Ciarla
 * @package plugin
 * @subpackage entity_manager/class/abstract/join/find
 */
class EntityManager_Join_Find extends EntityManager_Abstract_Function implements EntityManager_Interface_Function
{
	/**
	 * Statement sql clausola select
	 *
	 * @var string
	 */
	public $_selectSql;

	/**
	 * Statement sql clausola where
	 *
	 * @var string
	 */
	public $_whereSql;

	/**
	 * Lista dei valori da bindare
	 *
	 * @var array
	 */
	public $_bindWhereValue = array();

	/**
	 * Entity su cui agganciare la join
	 *
	 * @var EntityManager_Abstract_Entity
	 */
	public $_joinEntity;

	/**
	 * Statement sql clausola join
	 *
	 * @var string
	 */
	public $_joinSql;

	/**
	 * Statement sql clausola group by
	 *
	 * @var string
	 */
	public $_groupBySql;

	/**
	 * Statement sql clausola order by
	 *
	 * @var string
	 */
	public $_orderBySql;

	/**
	 * Statement sql clausola limit
	 *
	 * @var string
	 */
	public $_limitSql;

	/**
	 * Alias del nome della tabella
	 *
	 * @var string
	 */
	public $_alias;

	/**
	 * Tipo di join
	 *
	 * @var string
	 */
	public $_joinType;

	/**
	 * Istanza della classe che gestisce le join per la singola funzione
	 *
	 * @var EntityManager_JoinManager_Find
	 */
	private $_joinManager;

	public function __construct(EntityManager_JoinManager_Find $joinManager, $joinType, EntityManager_Abstract_Entity $entity, EntityManager_Abstract_Entity $joinEntity, $joinSql)
	{
		$this->_joinManager = $joinManager;

		$this->_joinType	= $joinType;
		$this->_entity		= $entity;
		$this->_joinEntity	= $joinEntity;

		// Recupero le informazioni della entity corrente
		$propertyEntity = $entity->getProperty();

		// Imposto l'alias della tabella con il nome della tabella corrente
		$this->_alias = $propertyEntity['ENTITY']['TABLE'];

		// Verifico se ci sono già delle tabelle nelle join della query. In caso positivo
		// eseguo una ricerca per verificare se esiste già una tabella dello stesso tipo
		// altrimenti verifico se l'entità corrente è uguale alla principale
		if($entity == $this->_joinManager->_functionInstance->_getEntity())
		{
			// Recupero le informazioni della entity a cui deve agganciarsi quella corrente
			$joinEntity = $joinEntity->getProperty();

			// Aggiungo all'alias corrente un suffisso uguale a se stesso es. "user_user"
			$this->_alias .= "_" . $joinEntity['ENTITY']['TABLE'];
		}
		else
		{
			// Scansione tutte le entità che devono affetuare una join
			foreach($joinManager->getTables() as $joinInstance)
			{
				// Verifico se la entity corrente è uguale ad una di quelle già presenti nella lista
				if($joinInstance->_getEntity() == $entity)
				{
					// Modifico l'alias alla entity corrente
					$propertyJoin = $joinEntity->getProperty();
					$this->_alias .= "_" . $propertyJoin['ENTITY']['TABLE'];

					// Modifico l'alias alla entity gemella già utilizzata
					$propertyJoin = $joinInstance->_joinEntity->getProperty();
					$joinInstance->_alias .= "_" . $propertyJoin['ENTITY']['TABLE'];
				}
			}
		}

		$this->_joinSql = $joinSql;
	}

	/**
	 * Metodo per scegliere i campi da visualizzare nel risultato finale. Se il metodo non viene chiamato
	 * vengono presi di default tutti i campi della tabella tramite il simbolo '*'
	 *
	 * <code>
	 * EntityManager::find(new Role)
	 * ->join(new User)
	 * <b>->select("name","surname")</b>
	 * <i>oppure</i>
	 * ->select(array("name","username"))
	 * ->execute();
	 * </code>
	 *
	 * @param string|array $fields Lista dei campi da inserire nella select sotto forma di array o stringa con valori separati da virgola
	 *
	 * @return EntityManager_Join_Find
	 */
	public function select($fields)
	{
		$properties = $this->_entity->getProperty();

		if($fields != "*")
		{
			$fields = ((is_string($fields)) ? explode(",", $fields) : $fields);

			if(count($fields) == 0)
			{
				/**
				 * @see EntityManager_Exception::NO_FIELD_SET
				 */
				throw new EntityManager_Exception(get_class($this->_entity), EntityManager_Exception::NO_FIELD_SET);
			}

			foreach($fields as $index => $field)
			{
				$field = trim($field);

				if(!is_string($field))
				{
					/**
					 * @see EntityManager_Exception::FIELD_TYPE_IS_NOT_A_STRING
					 */
					throw new EntityManager_Exception($field, EntityManager_Exception::FIELD_TYPE_IS_NOT_A_STRING);
				}

				if(!array_key_exists($field, $properties['FIELDS']))
				{
					/**
					 * @see EntityManager_Exception::FIELD_NOT_FOUND_INTO_SELECT
					 */
					throw new EntityManager_Exception(array($field, get_class($this->_entity)), EntityManager_Exception::FIELD_NOT_FOUND_INTO_SELECT);
				}

				$fields[$index] = $properties['ENTITY']['TABLE'] . "." . $field;
			}

			$this->_selectSql = $fields;
		}

		return $this;
	}

	/**
	 * Metodo che aggiunge delle custom where da eseguire o savrascrivere a quelle create
	 * dai parametri della entity
	 *
	 * <code>
	 * EntityManager::find(new Role)
	 * ->join(new User)
	 * <b>->where("name")->METHOD(...)</b>
	 * ->execute();
	 * </code>
	 *
	 * @param string $field Campo della tabella presente nella entity
	 *
	 * @return EntityManager_Where_JoinFind
	 */
	public function where($field)
	{
		$properties = $this->_entity->getProperty();

		if(!key_exists($field, $properties['FIELDS']))
		{
			/**
			 * @see EntityManager_Exception::FIELD_NOT_FOUND_INTO_WHERE
			 */
			throw new EntityManager_Exception(array($field, get_class($this->_entity)), EntityManager_Exception::FIELD_NOT_FOUND_INTO_WHERE);
		}

		return EntityManager_Where_JoinFind::getInstance($this, $field);
	}

	/**
	 * Aggiunge un parametro alla clausola order by
	 *
	 * <code>
	 * EntityManager::find(new Role)
	 * ->join(new User)
	 * <b>->orderBy("name", "ASC")</b>
	 * ->execute();
	 * </code>
	 *
	 * @param string $field Nome del campo
	 * @param string $value Valore della condizione "asc|desc"
	 *
	 * @return EntityManager_Join_Find
	 */
	public function orderBy($field, $value)
	{
		$properties = $this->_entity->getProperty();

		if(!key_exists($field, $properties['FIELDS']))
		{
			/**
			 * @see EntityManager_Exception::FIELD_NOT_FOUND_INTO_ORDER_BY
			 */
			throw new EntityManager_Exception(array($field, get_class($this->_entity)), EntityManager_Exception::FIELD_NOT_FOUND_INTO_ORDER_BY);
		}

		$value = strtoupper($value);

		if($value != "ASC" && $value != "DESC")
		{
			/**
			 * @see EntityManager_Exception::FIELD_NOT_FOUND_INTO_ORDER_BY
			 */
			throw new EntityManager_Exception("", EntityManager_Exception::INCORRECT_ORDER_BY_VALUE);
		}

		$this->_orderBySql = (($this->_orderBySql !== null) ? ", " : "") . $properties['ENTITY']['TABLE'] . "." . $field . " " . $value;

		return $this;
	}

	/**
	 * Metodo per aggiungere uno i più campi da inserire nella group by della query
	 *
	 * <code>
	 * EntityManager::find(new Role)
	 * ->join($User)
	 * <b>->groupBy("name")</b>
	 * ->execute();
	 * </code>
	 *
	 * @return EntityManager_Join_Find
	 */
	public function groupBy($fields)
	{
		$properties = $this->_entity->getProperty();

		$fields = ((is_string($fields)) ? explode(",", $fields) : $fields);

		if(count($fields) == 0)
		{
			/**
			 * @see EntityManager_Exception::NO_GROUP_BY_SET
			 */
			throw new EntityManager_Exception(get_class($this->_entity), EntityManager_Exception::NO_GROUP_BY_SET);
		}

		foreach($fields as $index => $field)
		{
			$field = trim($field);

			if(!key_exists($field, $properties['FIELDS']))
			{
				/**
				 * @see EntityManager_Exception::FIELD_NOT_FOUND_INTO_GROUP_BY
				 */
				throw new EntityManager_Exception(array($field, get_class($this->_entity)), EntityManager_Exception::FIELD_NOT_FOUND_INTO_GROUP_BY);
			}
		}

		$this->_groupBySql = $properties['ENTITY']['TABLE'] . "." . implode(", " . $properties['ENTITY']['TABLE'] . ".", $fields);

		return $this;
	}

	/**
	 * Metodo per aggiungere un limite nel recupero dei risultati
	 *
	 * <code>
	 * EntityManager::find(new Role)
	 * ->join($User)
	 * <b>->limit(0, 20)</b>
	 * ->execute();
	 * </code>
	 *
	 * @return EntityManager_Join_Find
	 */
	public function limit($start, $numRows)
	{
		$this->_limitSql = $start . ", " . $numRows;

		return $this;
	}

	/**
	 * Metodo che mette in join una entity con la precedente o con un eventuale entity
	 * specificata nel secondo parametro. Se la relazione non è presente tra le due entità
	 * è possibile specificare su quali campi effettuare la join
	 *
	 * @param EntityManager_Abstract_Entity $entity Istanza della entity su cui fare la join
	 * @param string $previusEntity Nome della entity sui cui agganciare la join ad una entity precedente
	 * @param string $customJoin Relazione tra le due entità specificate in questi parametri
	 *
	 * @return EntityManager_Join_Find
	 */
	public function join(EntityManager_Abstract_Entity $entity, $previusEntity = null, $customJoin = null)
	{
		return $this->_joinManager->join("INNER JOIN", $entity, $previusEntity, $customJoin);
	}

	/**
	 * Metodo che mette in left join una entity con la precedente o con un eventuale entity
	 * specificata nel secondo parametro. Se la relazione non è presente tra le due entità
	 * è possibile specificare su quali campi effettuare la join
	 *
	 * @param EntityManager_Abstract_Entity $entity Istanza della entity su cui fare la join
	 * @param string $previusEntity Nome della entity sui cui agganciare la join ad una entity precedente
	 * @param string $customJoin Relazione tra le due entità specificate in questi parametri
	 *
	 * @return EntityManager_Join_Find
	 */
	public function leftJoin(EntityManager_Abstract_Entity $entity, $previusEntity = null, $customJoin = null)
	{
		return $this->_joinManager->join("LEFT JOIN", $entity, $previusEntity, $customJoin);
	}

	/**
	 * Metodo che mette in right join una entity con la precedente o con un eventuale entity
	 * specificata nel secondo parametro. Se la relazione non è presente tra le due entità
	 * è possibile specificare su quali campi effettuare la join
	 *
	 * @param EntityManager_Abstract_Entity $entity Istanza della entity su cui fare la join
	 * @param string $previusEntity Nome della entity sui cui agganciare la join ad una entity precedente
	 * @param string $customJoin Relazione tra le due entità specificate in questi parametri
	 *
	 * @return EntityManager_Join_Find
	 */
	public function rightJoin(EntityManager_Abstract_Entity $entity, $previusEntity = null, $customJoin = null)
	{
		return $this->_joinManager->join("RIGHT JOIN", $entity, $previusEntity, $customJoin);
	}

	/**
	 * Metodo che esegue la query costruita in base ai valori impostati nella entity
	 * o a quelli aggiuntivi settati con i metodi presenti in questa classe
	 *
	 * @param boolean $returnArrayAssoc Parametro che imposta se ricevere il risultato sotto forma di array associativo o di array di entity
	 *
	 * @return array
	 */
	public function execute($returnArrayAssoc = false)
	{
		return $this->_joinManager->execute($returnArrayAssoc);
	}
}
?>
